<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>MixAudioConfigParamsWMA</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
<link rel="start" href="index.html" title="MixAudio Reference Manual">
<link rel="up" href="ch01.html" title="Mix Audio API">
<link rel="prev" href="MixAudio-MixAudioConfigParamsMP3.html" title="MixAudioConfigParamsMP3">
<link rel="next" href="MixAudio-MixAudioConfigParams.html" title="MixAudioConfigParams">
<meta name="generator" content="GTK-Doc V1.11 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="chapter" href="ch01.html" title="Mix Audio API">
<link rel="chapter" href="tree-hierarchy.html" title="Object Hierarchy">
<link rel="index" href="api-index-full.html" title="API Index">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="MixAudio-MixAudioConfigParamsMP3.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">MixAudio Reference Manual</th>
<td><a accesskey="n" href="MixAudio-MixAudioConfigParams.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#MixAudio-MixAudioConfigParamsWMA.synopsis" class="shortcut">Top</a>
                 | 
                <a href="#MixAudio-MixAudioConfigParamsWMA.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry" lang="en">
<a name="MixAudio-MixAudioConfigParamsWMA"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="MixAudio-MixAudioConfigParamsWMA.top_of_page"></a>MixAudioConfigParamsWMA</span></h2>
<p>MixAudioConfigParamsWMA — Audio parameters for WMA audio.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="MixAudio-MixAudioConfigParamsWMA.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">

#include &lt;mixacpwma.h&gt;

enum                <a class="link" href="MixAudio-MixAudioConfigParamsWMA.html#MixAudioWMAVersion" title="enum MixAudioWMAVersion">MixAudioWMAVersion</a>;
                    <a class="link" href="MixAudio-MixAudioConfigParamsWMA.html#MixAudioConfigParamsWMA" title="MixAudioConfigParamsWMA">MixAudioConfigParamsWMA</a>;
<a class="link" href="MixAudio-MixAudioConfigParamsWMA.html#MixAudioConfigParamsWMA" title="MixAudioConfigParamsWMA">MixAudioConfigParamsWMA</a> * <a class="link" href="MixAudio-MixAudioConfigParamsWMA.html#mix-acp-wma-new" title="mix_acp_wma_new ()">mix_acp_wma_new</a>               (void);
<a class="link" href="MixAudio-MixAudioConfigParamsWMA.html#MixAudioConfigParamsWMA" title="MixAudioConfigParamsWMA">MixAudioConfigParamsWMA</a> * <a class="link" href="MixAudio-MixAudioConfigParamsWMA.html#mix-acp-wma-ref" title="mix_acp_wma_ref ()">mix_acp_wma_ref</a>               (<a class="link" href="MixAudio-MixAudioConfigParamsWMA.html#MixAudioConfigParamsWMA" title="MixAudioConfigParamsWMA">MixAudioConfigParamsWMA</a> *mix);
#define             <a class="link" href="MixAudio-MixAudioConfigParamsWMA.html#mix-acp-wma-unref" title="mix_acp_wma_unref()">mix_acp_wma_unref</a>                   (obj)
#define             <a class="link" href="MixAudio-MixAudioConfigParamsWMA.html#MIX-ACP-WMA-CHANNEL-MASK--CAPS" title="MIX_ACP_WMA_CHANNEL_MASK()">MIX_ACP_WMA_CHANNEL_MASK</a>            (obj)
#define             <a class="link" href="MixAudio-MixAudioConfigParamsWMA.html#MIX-ACP-WMA-FORMAT-TAG--CAPS" title="MIX_ACP_WMA_FORMAT_TAG()">MIX_ACP_WMA_FORMAT_TAG</a>              (obj)
#define             <a class="link" href="MixAudio-MixAudioConfigParamsWMA.html#MIX-ACP-WMA-BLOCK-ALIGN--CAPS" title="MIX_ACP_WMA_BLOCK_ALIGN()">MIX_ACP_WMA_BLOCK_ALIGN</a>             (obj)
#define             <a class="link" href="MixAudio-MixAudioConfigParamsWMA.html#MIX-ACP-WMA-ENCODE-OPT--CAPS" title="MIX_ACP_WMA_ENCODE_OPT()">MIX_ACP_WMA_ENCODE_OPT</a>              (obj)
#define             <a class="link" href="MixAudio-MixAudioConfigParamsWMA.html#MIX-ACP-WMA-PCM-BIT-WIDTH--CAPS" title="MIX_ACP_WMA_PCM_BIT_WIDTH()">MIX_ACP_WMA_PCM_BIT_WIDTH</a>           (obj)
<a class="link" href="MixAudio-MixAudioConfigParamsWMA.html#MixAudioWMAVersion" title="enum MixAudioWMAVersion">MixAudioWMAVersion</a>  <a class="link" href="MixAudio-MixAudioConfigParamsWMA.html#mix-acp-wma-get-version" title="mix_acp_wma_get_version ()">mix_acp_wma_get_version</a>             (<a class="link" href="MixAudio-MixAudioConfigParamsWMA.html#MixAudioConfigParamsWMA" title="MixAudioConfigParamsWMA">MixAudioConfigParamsWMA</a> *obj);
MIX_RESULT          <a class="link" href="MixAudio-MixAudioConfigParamsWMA.html#mix-acp-wma-set-version" title="mix_acp_wma_set_version ()">mix_acp_wma_set_version</a>             (<a class="link" href="MixAudio-MixAudioConfigParamsWMA.html#MixAudioConfigParamsWMA" title="MixAudioConfigParamsWMA">MixAudioConfigParamsWMA</a> *obj,
                                                         <a class="link" href="MixAudio-MixAudioConfigParamsWMA.html#MixAudioWMAVersion" title="enum MixAudioWMAVersion">MixAudioWMAVersion</a> ver);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="MixAudio-MixAudioConfigParamsWMA.description"></a><h2>Description</h2>
<p>
A data object which stores audio specific parameters for WMA.
</p>
<p>
In Moorestown, only WMA2 is supported.
</p>
<p>
Additional parameters must be set in the parent object <a class="link" href="MixAudio-MixAudioConfigParams.html#MixAudioConfigParams" title="MixAudioConfigParams"><span class="type">MixAudioConfigParams</span></a></p>
</div>
<div class="refsect1" lang="en">
<a name="MixAudio-MixAudioConfigParamsWMA.details"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="MixAudioWMAVersion"></a><h3>enum MixAudioWMAVersion</h3>
<pre class="programlisting">typedef enum {
  MIX_AUDIO_WMA_VUNKNOWN,
  MIX_AUDIO_WMA_V9,
  MIX_AUDIO_WMA_V10,
  MIX_AUDIO_WMA_V10P,
  MIX_AUDIO_WMA_LAST
} MixAudioWMAVersion;
</pre>
<p>
WMA version.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="MIX-AUDIO-WMA-VUNKNOWN--CAPS"></a><span class="term"><code class="literal">MIX_AUDIO_WMA_VUNKNOWN</code></span></p></td>
<td> WMA version undefined.
</td>
</tr>
<tr>
<td><p><a name="MIX-AUDIO-WMA-V9--CAPS"></a><span class="term"><code class="literal">MIX_AUDIO_WMA_V9</code></span></p></td>
<td> WMA 9
</td>
</tr>
<tr>
<td><p><a name="MIX-AUDIO-WMA-V10--CAPS"></a><span class="term"><code class="literal">MIX_AUDIO_WMA_V10</code></span></p></td>
<td> <span class="emphasis"><em>Not Supported</em></span> WMA 10
</td>
</tr>
<tr>
<td><p><a name="MIX-AUDIO-WMA-V10P--CAPS"></a><span class="term"><code class="literal">MIX_AUDIO_WMA_V10P</code></span></p></td>
<td> <span class="emphasis"><em>Not Supported</em></span> WMA 10 Pro
</td>
</tr>
<tr>
<td><p><a name="MIX-AUDIO-WMA-LAST--CAPS"></a><span class="term"><code class="literal">MIX_AUDIO_WMA_LAST</code></span></p></td>
<td> last entry.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="MixAudioConfigParamsWMA"></a><h3>MixAudioConfigParamsWMA</h3>
<pre class="programlisting">typedef struct {
  MixAudioConfigParams parent;

  /* Audio Format Parameters */
  guint32 channel_mask;
  guint16 format_tag;
  guint16 block_align;
  guint16 wma_encode_opt;/* Encoder option */
  guint8 pcm_bit_width;  /* source pcm bit width */
  MixAudioWMAVersion wma_version;
} MixAudioConfigParamsWMA;
</pre>
<p>
MI-X Audio Parameter object</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><a class="link" href="MixAudio-MixAudioConfigParams.html#MixAudioConfigParams" title="MixAudioConfigParams">MixAudioConfigParams</a> <em class="structfield"><code>parent</code></em>;</span></p></td>
<td> parent.
</td>
</tr>
<tr>
<td><p><span class="term">guint32 <em class="structfield"><code>channel_mask</code></em>;</span></p></td>
<td> Channel Mask. See <a class="link" href="MixAudio-MixAudioConfigParamsWMA.html#MIX-ACP-WMA-CHANNEL-MASK--CAPS" title="MIX_ACP_WMA_CHANNEL_MASK()"><span class="type">MIX_ACP_WMA_CHANNEL_MASK</span></a>
</td>
</tr>
<tr>
<td><p><span class="term">guint16 <em class="structfield"><code>format_tag</code></em>;</span></p></td>
<td> Format tag. See <a class="link" href="MixAudio-MixAudioConfigParamsWMA.html#MIX-ACP-WMA-FORMAT-TAG--CAPS" title="MIX_ACP_WMA_FORMAT_TAG()"><span class="type">MIX_ACP_WMA_FORMAT_TAG</span></a>
</td>
</tr>
<tr>
<td><p><span class="term">guint16 <em class="structfield"><code>block_align</code></em>;</span></p></td>
<td></td>
</tr>
<tr>
<td><p><span class="term">guint16 <em class="structfield"><code>wma_encode_opt</code></em>;</span></p></td>
<td> Encoder option. See <a class="link" href="MixAudio-MixAudioConfigParamsWMA.html#MIX-ACP-WMA-ENCODE-OPT--CAPS" title="MIX_ACP_WMA_ENCODE_OPT()"><span class="type">MIX_ACP_WMA_ENCODE_OPT</span></a>
</td>
</tr>
<tr>
<td><p><span class="term">guint8 <em class="structfield"><code>pcm_bit_width</code></em>;</span></p></td>
<td> Source pcm bit width. See <a class="link" href="MixAudio-MixAudioConfigParamsWMA.html#MIX-ACP-WMA-PCM-BIT-WIDTH--CAPS" title="MIX_ACP_WMA_PCM_BIT_WIDTH()"><span class="type">MIX_ACP_WMA_PCM_BIT_WIDTH</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><a class="link" href="MixAudio-MixAudioConfigParamsWMA.html#MixAudioWMAVersion" title="enum MixAudioWMAVersion">MixAudioWMAVersion</a> <em class="structfield"><code>wma_version</code></em>;</span></p></td>
<td> WMA version. See <a class="link" href="MixAudio-MixAudioConfigParamsWMA.html#mix-acp-wma-set-version" title="mix_acp_wma_set_version ()"><span class="type">mix_acp_wma_set_version</span></a>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="mix-acp-wma-new"></a><h3>mix_acp_wma_new ()</h3>
<pre class="programlisting"><a class="link" href="MixAudio-MixAudioConfigParamsWMA.html#MixAudioConfigParamsWMA" title="MixAudioConfigParamsWMA">MixAudioConfigParamsWMA</a> * mix_acp_wma_new               (void);</pre>
<p>
Use this method to create new instance of <a class="link" href="MixAudio-MixAudioConfigParamsWMA.html#MixAudioConfigParamsWMA" title="MixAudioConfigParamsWMA"><span class="type">MixAudioConfigParamsWMA</span></a></p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>returns</code></em> :</span></p></td>
<td> A newly allocated instance of <a class="link" href="MixAudio-MixAudioConfigParamsWMA.html#MixAudioConfigParamsWMA" title="MixAudioConfigParamsWMA"><span class="type">MixAudioConfigParamsWMA</span></a>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="mix-acp-wma-ref"></a><h3>mix_acp_wma_ref ()</h3>
<pre class="programlisting"><a class="link" href="MixAudio-MixAudioConfigParamsWMA.html#MixAudioConfigParamsWMA" title="MixAudioConfigParamsWMA">MixAudioConfigParamsWMA</a> * mix_acp_wma_ref               (<a class="link" href="MixAudio-MixAudioConfigParamsWMA.html#MixAudioConfigParamsWMA" title="MixAudioConfigParamsWMA">MixAudioConfigParamsWMA</a> *mix);</pre>
<p>
Add reference count.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>mix</code></em> :</span></p></td>
<td> object to add reference
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>returns</code></em> :</span></p></td>
<td> the MixAudioConfigParamsWMA instance where reference count has been increased.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="mix-acp-wma-unref"></a><h3>mix_acp_wma_unref()</h3>
<pre class="programlisting">#define mix_acp_wma_unref(obj) mix_params_unref(MIX_PARAMS(obj))
</pre>
<p>
Decrement reference count of the object.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td> object to unref.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="MIX-ACP-WMA-CHANNEL-MASK--CAPS"></a><h3>MIX_ACP_WMA_CHANNEL_MASK()</h3>
<pre class="programlisting">#define MIX_ACP_WMA_CHANNEL_MASK(obj) (MIX_AUDIOCONFIGPARAMSWMA(obj)-&gt;channel_mask)
</pre>
<p>
MixAudioConfigParamWMA.channel_mask accessor.
</p>
<p>
Channel mask must be one of the following:
</p>
<p>
4: For single (1) channel output.
</p>
<p>
3: For stereo (2) channels output.
</p>
<p>
Only 1 or 2 output channels are supported.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td> <a class="link" href="MixAudio-MixAudioConfigParamsWMA.html#MixAudioConfigParamsWMA" title="MixAudioConfigParamsWMA"><span class="type">MixAudioConfigParamsWMA</span></a> object
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="MIX-ACP-WMA-FORMAT-TAG--CAPS"></a><h3>MIX_ACP_WMA_FORMAT_TAG()</h3>
<pre class="programlisting">#define MIX_ACP_WMA_FORMAT_TAG(obj) (MIX_AUDIOCONFIGPARAMSWMA(obj)-&gt;format_tag)
</pre>
<p>
MixAudioConfigParamWMA.format_tag accessor.
</p>
<p>
<em><span class="remark">In Moorestown, only value 0x0161 combined with use of <a class="link" href="MixAudio-MixAudioConfigParamsWMA.html#MIX-AUDIO-WMA-V9--CAPS"><span class="type">MIX_AUDIO_WMA_V9</span></a> is supported.</span></em></p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td> <a class="link" href="MixAudio-MixAudioConfigParamsWMA.html#MixAudioConfigParamsWMA" title="MixAudioConfigParamsWMA"><span class="type">MixAudioConfigParamsWMA</span></a> object
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="MIX-ACP-WMA-BLOCK-ALIGN--CAPS"></a><h3>MIX_ACP_WMA_BLOCK_ALIGN()</h3>
<pre class="programlisting">#define MIX_ACP_WMA_BLOCK_ALIGN(obj) (MIX_AUDIOCONFIGPARAMSWMA(obj)-&gt;block_align)
</pre>
<p>
MixAudioConfigParamWMA.block_align accessor.
</p>
<p>
Block alignment indicates packet size. Available from ASF Header.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td> <a class="link" href="MixAudio-MixAudioConfigParamsWMA.html#MixAudioConfigParamsWMA" title="MixAudioConfigParamsWMA"><span class="type">MixAudioConfigParamsWMA</span></a> object
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="MIX-ACP-WMA-ENCODE-OPT--CAPS"></a><h3>MIX_ACP_WMA_ENCODE_OPT()</h3>
<pre class="programlisting">#define MIX_ACP_WMA_ENCODE_OPT(obj) (MIX_AUDIOCONFIGPARAMSWMA(obj)-&gt;wma_encode_opt)
</pre>
<p>
MixAudioConfigParamWMA.wma_encode_opt accessor.
</p>
<p>
Encoder option available from ASF header.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td> <a class="link" href="MixAudio-MixAudioConfigParamsWMA.html#MixAudioConfigParamsWMA" title="MixAudioConfigParamsWMA"><span class="type">MixAudioConfigParamsWMA</span></a> object
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="MIX-ACP-WMA-PCM-BIT-WIDTH--CAPS"></a><h3>MIX_ACP_WMA_PCM_BIT_WIDTH()</h3>
<pre class="programlisting">#define MIX_ACP_WMA_PCM_BIT_WIDTH(obj) (MIX_AUDIOCONFIGPARAMSWMA(obj)-&gt;pcm_bit_width)
</pre>
<p>
MixAudioConfigParamWMA.pcm_bit_width accessor.
</p>
<p>
Source pcm bit width available from ASF Header.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td> <a class="link" href="MixAudio-MixAudioConfigParamsWMA.html#MixAudioConfigParamsWMA" title="MixAudioConfigParamsWMA"><span class="type">MixAudioConfigParamsWMA</span></a> object
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="mix-acp-wma-get-version"></a><h3>mix_acp_wma_get_version ()</h3>
<pre class="programlisting"><a class="link" href="MixAudio-MixAudioConfigParamsWMA.html#MixAudioWMAVersion" title="enum MixAudioWMAVersion">MixAudioWMAVersion</a>  mix_acp_wma_get_version             (<a class="link" href="MixAudio-MixAudioConfigParamsWMA.html#MixAudioConfigParamsWMA" title="MixAudioConfigParamsWMA">MixAudioConfigParamsWMA</a> *obj);</pre>
<p>
Get WMA Version.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td> <a class="link" href="MixAudio-MixAudioConfigParamsWMA.html#MixAudioConfigParamsWMA" title="MixAudioConfigParamsWMA"><span class="type">MixAudioConfigParamsWMA</span></a> object
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>returns</code></em> :</span></p></td>
<td> MixAudioWMAVersion
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="mix-acp-wma-set-version"></a><h3>mix_acp_wma_set_version ()</h3>
<pre class="programlisting">MIX_RESULT          mix_acp_wma_set_version             (<a class="link" href="MixAudio-MixAudioConfigParamsWMA.html#MixAudioConfigParamsWMA" title="MixAudioConfigParamsWMA">MixAudioConfigParamsWMA</a> *obj,
                                                         <a class="link" href="MixAudio-MixAudioConfigParamsWMA.html#MixAudioWMAVersion" title="enum MixAudioWMAVersion">MixAudioWMAVersion</a> ver);</pre>
<p>
Set WMA Version.
</p>
<p>
<em><span class="remark">In Moorestown, only <a class="link" href="MixAudio-MixAudioConfigParamsWMA.html#MIX-AUDIO-WMA-V9--CAPS"><span class="type">MIX_AUDIO_WMA_V9</span></a> is supported</span></em></p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td> <a class="link" href="MixAudio-MixAudioConfigParamsWMA.html#MixAudioConfigParamsWMA" title="MixAudioConfigParamsWMA"><span class="type">MixAudioConfigParamsWMA</span></a> object
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>ver</code></em> :</span></p></td>
<td> MixAudioWMAVersion to set.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>returns</code></em> :</span></p></td>
<td> MIX_RESULT.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.11</div>
</body>
</html>
